/*
Copyright (c) 2012 the VATSIM Connector project

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

#ifndef __XPINN__OBJECT_H__
#define __XPINN__OBJECT_H__

#include "xpinn.h"
#include <string>
#include <XPLMScenery.h>

/**
 * A class wrapping XPLMObjectRef and associated functions. A scenery object.
 *
 * Supports the RAII idiom.
 */
class XPInnObject : public XPInnWeakPtrSubject<XPInnObject>
{
public:
  /**
   * Constructor.
   */
  XPInnObject();

  /**
   * Destructor.
   */
  ~XPInnObject();

  /**
   * Returns true if the object is either loading or loaded.
   */
  bool isValid() const { return m_obj || m_isLoading; }

  /**
   * Loads an object file asynchronously.
   */
  void load(std::string const& filename);

  /**
   * Unloads any file associated with this object, thereby invalidating it.
   */
  void unload();

  /**
   * Draw the object.
   *
   * If the object is not yet loaded, this does nothing.
   */
  void draw(XPLMDrawInfo_t const&);

private:
  XPLMObjectRef m_obj;
  bool m_isLoading;
  std::string m_filename;

  static void objectLoadedCallback(XPLMObjectRef obj, void* refcon);

  static float getLitLevel();
};

#endif